home *** CD-ROM | disk | FTP | other *** search
/ FishMarket 1.0 / FishMarket v1.0.iso / fishies / 351-375 / disk_365 / badger / badger.doc < prev    next >
Text File  |  1992-05-06  |  18KB  |  414 lines
  1. -----------------------------------------------------------------------------
  2.  SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE 
  3. -----------------------------------------------------------------------------
  4.  
  5.        Program:  BADGER                                             03/28/90
  6.     Programmer:  George Kerber  
  7.        Written:  03/15/90 - 07/01/90  
  8.    Application:  MS-DOS & AmigaDOS 
  9.   
  10. This program is released as SHAREWARE.  This means that all users who find 
  11. this program useful and continue to use it are required to mail the author
  12. (me) $15 to pay for the program and to register their copy.  Failure to make
  13. the required payment is THEFT.  This program may be used for a period of 30
  14. days (one 30 day trial period per user) without charge.  Any user that
  15. continues to use the program past the 30 day trial period should mail
  16. payment to:  
  17.   
  18.                          George Kerber  
  19.                          19757 E. Linvale Drive  
  20.                          Aurora, CO  80013  
  21.                          (303) 693-2890  
  22.   
  23. As the author, I choose to make this program shareware and require a payment
  24. of $15 for the use of the program.  If anyone does not think the program is
  25. worth $15 (which is anyone's choice to make), that doesn't justify not
  26. making payment if you continue to use the program.  If my price it too high,
  27. then simply delete the program & documentation. 
  28.   
  29. Your permission to use this version of BADGER expires 30 days after the
  30. first time you execute the program.  Forty five days after you first use
  31. this program, BADGER will delete it's data files and become inoperative. 
  32. Whenever BADGER is executed, insure that your computer clock is set
  33. correctly.  The data files that are created by BADGER will only work with
  34. the copy of BADGER they were created with.  If a new copy of BADGER is
  35. started, it will destroy the old data files.  BADGER will not permit the
  36. user to set their computer date years ahead to start the program in an 
  37. attempt to get more usage time.  BADGER will detect this and become
  38. inoperative.
  39.    
  40. All registered users will receive an unprotected copy of the latest version
  41. of 'BADGER' that operates without any SHAREWARE message notices. The
  42. shareware screen was intended to be annoying.  Please send your registration
  43. payment, and you will never have to see the screen again.  Any attempt to
  44. remove the SHAREWARE notice using some type of sector editor will make the
  45. program inoperative.  When ordering, please specify MS-DOS or AmigaDOS.  
  46.  
  47. ---------------------------------------------------------------------------
  48. SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE 
  49. ---------------------------------------------------------------------------
  50.  
  51.     
  52. PURPOSE:  (MS-DOS or AmigaDOS)
  53. --------  
  54. BADGER is a 'quick' reminder program.  The user can enter important events
  55. via prompts, along with the number of days to pre-notify.  BADGER will 
  56. display any important events that fall within the pre-notify date from the
  57. menu or using the '-s' option.  The '-s' option will only display the 
  58. important events that are 'due'.  This is useful for inclusion in your
  59. autoexec.bat/startup-sequence file. 
  60.   
  61.   
  62. SYNTAX:  
  63. -------  
  64.   
  65.         BADGER  
  66.         BADGER -s   
  67.         BADGER -c (MS-DOS Only)
  68.         BADGER -l (MS-DOS Only)
  69.         BADGER -check
  70.         BADGER -h (MS-DOS only) or ? (MS-DOS & AmigaDOS)
  71.  
  72.         With no option BADGER will display a menu to add, view or search
  73.         for current due events.   BADGER is easy to use, most choices are   
  74.         self-explanatory.
  75.     
  76.         -s  BADGER will display only the current due important events and 
  77.             then exit.  If no events are due, there will be no output.
  78.             Add 'BADGER -s' this to your autoexec.bat file.  
  79.  
  80.         -c  Toggle color/black & white.  See the section titled "COLOR"
  81.             for more information.  (MS-DOS ONLY)
  82.  
  83.         -l  This option prevents BADGER from using any text attributes
  84.             in it's display.  This is useful for LCD displays due to the
  85.             "reversed" nature of their output.  See the section titled
  86.             "COLOR" for more information.  (MS-DOS ONLY)
  87.  
  88.     -check  This option will display the status of this copy of BADGER,
  89.             along with the compile date.  If this copy is a SHAREWARE
  90.             version, '-check' will also display to the user if this copy 
  91.             of BADGER has ever been executed.  See the 'STATUS' section
  92.             for more information about this option for SHAREWARE users.
  93.  
  94.         -h  A short help/information screen will be displayed. 
  95.  
  96.               or
  97.  
  98.          ?  A short help/information screen will be displayed.
  99.  
  100.        
  101. When choices appear between [] brackets, any choice that is capitalized is  
  102. the default and can be selected by simply pressing any key.  
  103.  
  104.   
  105. MENU OPERATION  
  106. ---------------  
  107. All menu selections can be selected by the choice number or the highlighted
  108. letter of the description.   
  109.   
  110.     (s)     1.  Search For Important Events.  
  111.   
  112.     (a)     2.  Add Events.  
  113.   
  114.     (v)     3.  View Events.  
  115.   
  116.     (h)     4.  Help/Information. 
  117.  
  118.     (P)         Print Event List.  (not shown on menu)
  119.  
  120.     (q)     5.  Quit. (default)  
  121.   
  122. 1.  (s) Any important events that are "due" will be displayed.  The user  
  123.         will have six possible choices.  
  124.   
  125.     1.  (s) Snooze:  This is the default and will be selected by pressing
  126.             any key not used for the other menu choices.  The event will
  127.             be kept and the user will be reminded again the next time the
  128.             program is executed.  
  129.   
  130.     2.  (d) Delete:  The event will be deleted from memory.  
  131.  
  132.     3.  (q) Quit:  Or press ESC to return to the main menu. 
  133.  
  134.     4.  (w) Remind Again Next Week:  The event will be moved ahead seven
  135.         days from the Important Event date.   
  136.   
  137.     5.  (m) Remind Again Next Month:  The event will be moved to the same
  138.             date in the next month if possible.  If the new date is invalid,
  139.             the day will be moved to the last day in the new month.   
  140.  
  141.             Example:  05/31/90 will be changed to 06/30/90.  
  142.  
  143.             If you want to be reminded of an event at the end of every  
  144.             month, enter the event for the 1st day of the next month to  
  145.             notify you a few days before that.  This will insure that you  
  146.             will always be notified the same number of days before the end
  147.             of each month, no matter how many days are in the month.  
  148.     
  149.     6.  (y) Remind Again Next Year:  The event will be moved to the next 
  150.             year in the list.  Any dates of 2/29/LEAPYEAR will be moved to 
  151.             2/28 of the next year.   
  152.   
  153. 2.  (a) The user will be prompted for a date.  The date must be entered as
  154.         m/d or m/d/y.  If no year is entered, current year is assumed.  
  155.         Leading zero's can be entered, but they are not required.  Today  
  156.         Today or later is all that will be accepted up until year 2030. 
  157.   
  158.     Enter the number of days you would like to be reminded of this event 
  159.     ahead of time.  The default is 10 days.  You can enter 0 - 45 days.  
  160.   
  161.     Enter a description of the event.  This is the message that will be  
  162.     displayed to the user when the event is displayed.  
  163.           
  164. 3.  (v) The user will be presented with a sequential display of all events
  165.         in the file.  Events can be deleted with this choice.    
  166.  
  167. 4.  (h)  A short help/information screen will be displayed. 
  168.  
  169.     (P)  Print Event List:  An uppercase "P" must be used for this option.
  170.          Selecting this option will print your entire Event List on
  171.          stdprn(MS-DOS) or prt:(AmigaDOS).  Insure that your printer is
  172.          turned on before selecting this option.  If any changes were
  173.          made to the Event List, the user will be prompted to store
  174.          the changes before printing begins.  It's usually a good idea
  175.          to store the changes at this point in case some printing error
  176.          develops.
  177.  
  178.          MS-DOS users must be especially careful to insure that their printer
  179.          is turned on & is operational, since MS-DOS will exit the program if
  180.          any errors are encountered.  Date loss could occur if your events
  181.          have not been saved and a printing error occurs.
  182.  
  183.          NOTE:  This option is not shown on the BADGER menu. 
  184.   
  185. 5.  (q)  If any changes were made to the event list, the user will be  
  186.          prompted to save or ignore the changes.  
  187.  
  188.     THE FOLLOWING CHOICES ARE NOT SHOWN ON THE MAIN BADGER MENU.
  189.  
  190.     (P)  Print Event List:  An uppercase "P" must be used for this option.
  191.          This option is only available if there are any events in the
  192.          Event List.  Selecting this option will print your entire Event 
  193.          List on stdprn(MS-DOS) or prt:(AmigaDOS).  Insure that your printer 
  194.          is turned on before selecting this option.  If any changes were
  195.          made to the Event List, the user will be prompted to store
  196.          the changes before printing begins.  It's usually a good idea
  197.          to store the changes at this point in case some printing error
  198.          developes.
  199.  
  200.          MS-DOS users must be especially careful to insure that their printer
  201.          is turned on & is operational, since MS-DOS will exit the program if
  202.          any errors are encountered.  Date loss could occur if your events
  203.          have not been saved and a printing error occurs.
  204.  
  205.     (W)  Write Event List:  An uppercase "W" must be used for this option.
  206.          This option is only available if any changes have been made to
  207.          the Event List.  Selecting an uppercase 'W' will write the Event
  208.          List to disk if any changes have been made.  Use of this option
  209.          is normally not necessary, since the user will be prompted to
  210.          save any changes on exit from the program.
  211.  
  212.   
  213. DATA FILE LOCATION:  
  214. -------------------  
  215. MS-DOS:
  216.  
  217. The BADGER program looks at the drive that it was executed from and assumes
  218. that this is the drive that the user wants to store the data file on.  So,
  219. if you have BADGER.EXE on your c: drive, BADGER will use
  220. c:\BADGER\BADGER.DAT for the data file.  Or if you have BADGER.EXE on the a:
  221. drive, BADGER will use A:\BADGER\BADGER.DAT instead.  This allows the
  222. program to be used by both hard drive and floppy disk users.  If a current
  223. file exists, then it will be renamed to 'BADGER.BAK' and the new information
  224. will be written to 'BADGER.DAT'.  This insures that the previous generation
  225. file will always be available in the \BADGER directory.  If the \BADGER
  226. directory doesn't exist, BADGER.EXE will create it.  
  227.  
  228. AmigaDOS:
  229.  
  230. BADGER stores the data file in your logically assigned s: directory.  The
  231. date file is named s:badger.data.  Whenever BADGER writes new information,
  232. badger.data (if it exists) is renamed to badger.bak and the new data is
  233. written to badger.data.  This insures that the previous generation file is
  234. always available if needed.
  235.  
  236.   
  237. AUTOEXEC.BAT (MS-DOS) / STARTUP-SEQUENCE (AmigaDOS) FILE  
  238. --------------------------------------------------------  
  239. Add the following line to your autoexec.bat/startup-sequence file after any 
  240. commands necessary to set your system clock.  
  241.   
  242.    BADGER -s  
  243.   
  244. Each time you boot your computer, BADGER will check for any important events
  245. that are 'due' and display them to the user.  If there is nothing to
  246. display, there will be no output.  See the RETURN CODE section below.  The
  247. display will be identical to the "Search For Important Events" from the
  248. BADGER menu, except that the user WILL NOT be prompted if any changes should
  249. be saved.  
  250.  
  251. AmigaDOS:
  252.  
  253. Since the Amiga is a multi-tasking machine, BADGER can be 'run' to allow
  254. your startup-sequence to continue in the background while BADGER is running.
  255. This allows BADGER to check and/or display events that are due while your
  256. startup-sequence continues.  If you desire to 'run' BADGER, add this line
  257. to your startup-sequence instead of 'badger -s':
  258.  
  259.    run >nil: badger -s
  260.   
  261.   
  262. INSTALLATION:  
  263. -------------  
  264.  
  265. MS-DOS:
  266.  
  267. Copy BADGER.EXE to any directory that is in your current path.  Remember 
  268. that BADGER will use the drive that you executed BADGER.EXE from for the  
  269. location of the data file as described above. 
  270.  
  271. BADGER will fail if a file named BADGER exists in the root directory of
  272. the disk you are running BADGER from.  This because BADGER will try and
  273. make a directory called BADGER and will fail if a file named BADGER exists.
  274.  
  275. AmigaDOS:
  276.  
  277. Badger and badger.info can be copied to any location on your disk.  If you
  278. copy badger to a directory that is not in your current path, you will have
  279. to give a fully qualified path when executing badger from your startup-
  280. sequence.  For example:  If dh0:extra is not in your current path and you
  281. have copied badger to this directory, you will need to enter 
  282.    
  283.    dh0:extra/badger -s
  284.  
  285. to your startup-sequence so your computer can find it.
  286.  
  287.  
  288. FLOPPY DISK USERS
  289. -----------------
  290. This program will work from floppy disks, but may be annoying slow to run
  291. each and every time your system is booted from every disk.  I suggest that a
  292. bootable (and writable) disk be created with the program run from the
  293. autoexec.bat/startup-sequence as described above.  Then simply boot from
  294. your BADGER disk whenever you want to check your event list.
  295.  
  296.  
  297. RETURN CODE  
  298. -----------  
  299. If an error occurs that terminates the program prematurely, a return code of
  300. 10 (ERROR) is passed to the DOS shell along with a message printed to the 
  301. screen informing the user.  
  302.  
  303. When the program is executed using the -s option, a return code of 5 (WARN)
  304. is returned to the DOS shell if there were important events to display.  No 
  305. messages or errors are displayed.  Adding 'BADGER -s' to your autoexec.bat/
  306. startup-sequence file will produce no output unless an important event is 
  307. displayed.
  308.  
  309. The user can safely ignore the return code if desired.   
  310.   
  311. AmigaDOS:
  312.  
  313. You can trap for a no-event condition by checking the return
  314. code in the script you are executing 'badger -s' from.
  315.  
  316. ....
  317.  
  318. badger -s
  319. if NOT WARN
  320.    echo "No Important Events Today"
  321.    endif
  322.  
  323. ....
  324.  
  325. If you want some type of message displayed if there were no important events
  326. to display, add the above code to your startup-sequence.  Otherwise badger
  327. -s will execute quietly unless there is an important event to display. 
  328.  
  329.  
  330.  
  331. Color: (MS-DOS users only, AmigaDOS always uses color)
  332. ------------------------------------------------------
  333. Text and background color is difficult to control in MS-DOS due to the many
  334. possible combinations of graphics cards and monitors.  Many programs will
  335. change the text or background colors for their use and not return them to 
  336. the original colors when the program ends.  This is poor programming.  BADGER
  337. always attempts to return your display to the way it found it.  BADGER 
  338. attempts to determine the type of video adapter and current textmode to
  339. determine if the display should be in color or black & white.  You can
  340. override the automatic choices using one of the methods shown below:
  341.  
  342. Using the '-c' option will cause the display to change to the opposite of
  343. the currently 'normal' display when executing BADGER with no option.
  344. That is, if BADGER normally displays in color, using the '-c' option will
  345. change the display to a black & white display, and vice-versa.  Of course
  346. you must have a color monitor and color video adapter to have a color
  347. display.
  348.  
  349. The '-c' option can be set with an environmental variable if desired to avoid
  350. having to specify the '-c' option every time BADGER is executed.  Add the
  351. following line (or enter it at the DOS prompt) to your autoexec.bat file.
  352.  
  353.                set NOCOLOR=x   (no spaces are allowed on either side
  354.                                 of the equals sign)
  355.  
  356. Using the '-l' option will cause the BADGER display to use no text attributes
  357. in it's display.  This can be useful when using an LCD display due to the
  358. "reversed" nature of their displays.  
  359.  
  360.                set NOCOLOR=LCD   (no spaces are allowed on either side
  361.                                   of the equals sign)
  362.  
  363. If the NOCOLOR environmental variable is set to LCD or the '-l' option is
  364. used, the '-c' option will have no effect.
  365.  
  366. If you are not using a color monitor, experiment with the NOCOLOR variable
  367. or the '-c' and '-l' options to get the best and most readable display.
  368.  
  369. Public domain programs UDATE (v1.21s+) and FORTUNE (v2.02s+) can also
  370. can read the NOCOLOR environmental variable if it's set.
  371.  
  372.  
  373. STATUS:  
  374. -------  
  375. This program is SHAREWARE.  If you find this program useful, you are
  376. required to mail the author $15 as payment for the program and to register
  377. your copy.
  378.  
  379. If you have a registered version of BADGER, you MAY NOT FREELY DISTRIBUTE
  380. your copy.  Only unregistered 'usage' protected copies may be freely
  381. distributed.  
  382.  
  383. Usage protected SHAREWARE versions of this program can be freely distributed 
  384. as long as all files are included in the archive.  The archive should 
  385. contain the following files:
  386.  
  387. MS-DOS:   1. badger.exe           AmigaDOS:  1. badger
  388.           2. badger.doc                      2. badger.doc
  389.           3. REGISTER                        3. REGISTER
  390.                                              4. badger.info (icon)
  391.  
  392. If a SHAREWARE copy of BADGER is redistributed, it should be the exact copy
  393. copy that was obtained from the archive.  This is, the copy that is
  394. distributed should not have been executed.  You can determine if BADGER has
  395. ever been executed by executing badger using '-check' as an option.  If
  396. If BADGER has been date-stamped, that copy should not be distributed, since
  397. since it will become inoperative 45 days from the first time it was 
  398. executed, not 45 days from when the new user first executes it.
  399.  
  400. Please specify MS-DOS (3 1/2 or 5 1/4) or AmigaDOS.  Failure to mail payment
  401. is THEFT, no different than stealing a program from a shelf in a store.  A
  402. ordering form has been provided in the text file "REGISTER".
  403.  
  404. I am not responsible for any failure of this program, or any missed events
  405. or any consequences of the missed event. (I hate responsibility)  
  406.    
  407.   
  408.                            George Kerber  
  409.                            19756 E. Linvale Drive  
  410.                            Aurora, Colorado  80013  
  411.                            303-692-2890  
  412.   
  413.                            Compuserve 74010,2132  
  414.